/*
 * Copyright (C) 2010-2025 Structr GmbH
 *
 * This file is part of Structr <http://structr.org>.
 *
 * Structr is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * Structr is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Structr.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.structr.core.function;

import org.structr.common.error.ArgumentCountException;
import org.structr.common.error.ArgumentNullException;
import org.structr.common.error.FrameworkException;
import org.structr.core.property.PropertyKey;
import org.structr.core.traits.Traits;
import org.structr.docs.Example;
import org.structr.docs.Parameter;
import org.structr.docs.Signature;
import org.structr.docs.Usage;
import org.structr.schema.SchemaHelper;
import org.structr.schema.action.ActionContext;

import java.util.List;

public class PropertyInfoFunction extends AdvancedScriptingFunction {


	@Override
	public String getName() {
		return "propertyInfo";
	}

	@Override
	public List<Signature> getSignatures() {
		return Signature.forAllScriptingLanguages("type, propertyName");
	}

	@Override
	public Object apply(final ActionContext ctx, final Object caller, final Object[] sources) throws FrameworkException {

		try {

			assertArrayHasLengthAndAllElementsNotNull(sources, 2);

			final String typeName = sources[0].toString();
			final String keyName = sources[1].toString();

			Traits traits = Traits.of(typeName);

			if (traits != null) {

				final PropertyKey key = traits.key(keyName);
				if (key != null) {

					return SchemaHelper.getPropertyInfo(ctx.getSecurityContext(), key);

				} else {

					logger.warn("Error: Unknown property \"{}.{}\". Parameters: {}", typeName, keyName, getParametersAsString(sources));
					return "Unknown property " + typeName + "." + keyName;
				}

			} else {

				logger.warn("Error: Unknown type \"{}\". Parameters: {}", typeName, getParametersAsString(sources));
				return "Unknown type " + typeName;
			}

		} catch (ArgumentNullException pe) {

			// silently ignore null arguments
			return null;

		} catch (ArgumentCountException pe) {

			logParameterError(caller, sources, pe.getMessage(), ctx.isJavaScriptContext());
			return usage(ctx.isJavaScriptContext());
		}
	}

	@Override
	public List<Usage> getUsages() {
		return List.of(
				Usage.structrScript("Usage: ${propertyInfo(type, name)}."),
				Usage.javaScript("Usage: ${{ $.propertyInfo(type, name) }}.")
		);
	}

	@Override
	public String getShortDescription() {
		return "Returns the schema information for the given property.";
	}

	@Override
	public String getLongDescription() {
		return """  
		Returns a property info object for the property of the given type with the given name. A property info object has the following structure:
	
		| Field | Description | Type |
		| --- | --- | --- |
		| dbName | Database (Neo4j) name - can be used in Cypher etc. | String |
		| jsonName | JSON name (as it appears in JSON REST output) | String |
		| className | Class name of the property type | String |
		| declaringClass | Name of the declaring class | String |
		| defaultValue | Default value or null | String |
		| contentType | Content type or null (String only) | String |
		| format | Format or null | String |
		| readOnly | Read-only flag | Boolean |
		| system | System flag | Boolean |
		| indexed | Indexed flag | Boolean |
		| indexedWhenEmpty | Indexed-when-empty flag | Boolean |
		| unique | Unique flag | Boolean |
		| notNull | Not-null flag | Boolean |
		| dynamic | Dynamic flag | Boolean |
		| relatedType | Related type (for relationship properties) | String |
		| type | Property type from definition | String |
		| uiType | Extended property type for Edit Mode (e.g. String, String[] etc.) | String |
		| isCollection | Collection or entity (optional) | String |
		| databaseConverter | Database converter type (internal) | String |
		| inputConverter | Input converter type (internal) | String |
		| relationshipType | Relationship type (for relationship properties) | String |
		""";
	}

	@Override
	public List<Example> getExamples() {
		return List.of(
				Example.structrScript("${propertyInfo('User', 'name').uiType}"),
				Example.javaScript("${{ $.propertyInfo('User', 'name').uiType }}")
		);
	}

	@Override
	public List<Parameter> getParameters() {

		return List.of(
				Parameter.mandatory("type", "type of the object"),
				Parameter.mandatory("name", "name of the object")
		);
	}
}
